Interface Information - Read Me
Contents
1.
KO Gateway Interface
2.
Logic node SDK
3.
Some useful links
4.
QuadClient SDK
5.
URL endpoints

1.KO Gateway Interface

The KO Gateway interface can be used to monitor and set communication objects with group addresses. The HS monitor included in the Expert from v4.7 onwards offers this functionality.

2. Logic block SDK

Since firmware 2.1, the HS/FS has been able to extend the logic functionality of the HS/FS with its own logic modules.

A distinction is made between HSL 1, HSL 2 and HSL 3.

2.1.HSL 1

The logic blocks since firmware 2.1. Detailed documentation on how they work and how to create them can be found at \HSL\HSL1.

2.2.HSL 2 (deprecated)

From firmware 4.5 up to and including firmware 4.13, logic blocks can be created based on the Python 2 programming language. Several tools are provided for development . In addition to detailed documentation on the creation and functionality of these blocks, there is a step-by-step ‘how-to’ guide for setting up your own development environment, complete documentation of the framework and the source codes of some example blocks (see \HSL\HSL2).

2.3.HSL 3

From firmware version 4.13 onwards, logic blocks can be created based on the Python 3 programming language and the HSL 3 framework. Please note that the framework and the version of the Python 3 programming language may change in future versions of the firmware. In addition to detailed documentation on the creation and functionality of these blocks, there is a step-by-step ‘how-to’ guide for setting up your own development environment, complete documentation of the framework and the source codes of some example blocks (see \HSL\HSL3).

2.4.Linking logic modules to serial numbers

Logic blocks can be linked to a specific HomeServer/FacilityServer (serial number) so that these blocks only work on the device with this serial number .

Two applications from the HS/FS Expert Setup are available for this purpose.
The documentation for this can be found under \HSL\AES_coding\.

3. Some useful links

4.QuadClient SDK

4.1.Function templates

Function templates are visual display elements for the QuadClient or the HS/FS apps. A function template defines the appearance (display) and behaviour of a function . In addition to the function templates already included in the setup, it is also possible to create custom function templates.

Further information can be found here:
  • Developer forum (https://www.entwicklerforum.gira.de/)
  • The description for creating function templates can be found under\Template SDK\.

4.2.Plug-ins

Plug-ins are independently operating programmes that can be embedded in QuadClient. In addition to the plug-ins already included in the setup, it is also possible to create custom plug-ins.

Further information can be found here:
  • Developer forum (https://www.entwicklerforum.gira.de/)
  • You can find instructions for creating plug-ins under \Plugin SDK\.

5.URL endpoints

HomeServer objects (such as communication objects, scenes, sequences, etc., see documentation) can be accessed or modified via a URL using an HTTPS call.
As an alternative to accessing via HTTPS, HS objects are also available via a WebSocket (WS) connection.
  • URL endpoints Documentation and notes on error analysis during development: see \URL Endpoint\documentation\.
  • JavaScript API: see \URL Endpoint\JS API\.